Vcenter VmTemplate LibraryItems CreateSpec
The Vcenter VmTemplate LibraryItems CreateSpec schema defines the information required to create a library item containing a virtual machine template.
This schema was added in vSphere API 6.8.
{
"source_vm": "string",
"name": "string",
"description": "string",
"library": "string",
"vm_home_storage": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
},
"disk_storage": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
},
"disk_storage_overrides": {
"disk_storage_overrides": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
}
},
"placement": {
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string"
}
}
Identifier of the source virtual machine to create the library item from.
This property was added in vSphere API 6.8.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine
.
Name of the library item.
This property was added in vSphere API 6.8.
Description of the library item.
This property was added in vSphere API 6.8.
If missing or null
, the newly created library item has the same description as the source virtual machine.
Identifier of the library in which the new library item should be created.
This property was added in vSphere API 6.8.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library
.
Storage location for the virtual machine template's configuration and log files.
This property was added in vSphere API 6.8.
If missing or null
, the virtual machine template's configuration and log files are placed on the default storage backing associated with the library specified by library.
Storage specification for the virtual machine template's disks.
This property was added in vSphere API 6.8.
If both disk_storage_overrides and disk_storage are missing or null
, the virtual machine template's disks are placed in the default storage backing associated with the library specified by library.
If disk_storage_overrides is missing or null
and disk_storage is specified, all of the virtual machine template's disks are created with the storage spec specified by disk_storage.
If disk_storage_overrides is specified and disk_storage is missing or null
, disks with identifiers that are not in disk_storage_overrides are placed in the default storage backing associated with the library specified by library.
If both disk_storage_overrides and disk_storage are specified, disks with identifiers that are not in disk_storage_overrides are created with the storage spec specified by disk_storage.
Storage specification for individual disks in the virtual machine template. This is specified as a mapping between disk identifiers in the source virtual machine and their respective storage specifications.
This property was added in vSphere API 6.8.
If both disk_storage_overrides and disk_storage are missing or null
, the virtual machine template's disks are placed in the default storage backing associated with the library specified by library.
If disk_storage_overrides is missing or null
and disk_storage is specified, all of the virtual machine template's disks are created with the storage spec specified by disk_storage.
If disk_storage_overrides is specified and disk_storage is missing or null
, disks with identifiers that are not in disk_storage_overrides are placed in the default storage backing associated with the library specified by library.
If both disk_storage_overrides and disk_storage are specified, disks with identifiers that are not in disk_storage_overrides are created with the storage spec specified by disk_storage.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk
. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk
.
Information used to place the virtual machine template.
This property was added in vSphere API 6.8.
This property is currently required. In the future, if this property is missing or null
, the system will place the virtual machine template on a suitable resource.
If specified, each property will be used for placement. If the properties result in disjoint placement, the operation will fail. If the properties along with the placement values of the source virtual machine result in disjoint placement, the operation will fail.